home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pledge12.zip / SYSOP.DOC < prev    next >
Text File  |  1992-12-15  |  8KB  |  223 lines
  1.  
  2.                              PLEDGE BANK  v1.2  
  3.  
  4.                             SYSOP DOCUMENTATION
  5.                                      
  6.                                      by
  7.                              
  8.                               Thomas W. Burker
  9.        
  10.        Using the GAPQBDR Interface Module from GAP Development Company
  11.                        and compiled QBasic code v4.5
  12.               Registered with the GAP Communications Company
  13.                             Registration # 5210    
  14.                        
  15.                         TomTron Software Development
  16.                   (c) copyright 1992 all rights reserved
  17.  
  18.  
  19.      The latest version of PLEDGE BANK is always available on PC NITELINE
  20.                in file directory #1 - TomTron Door Programs
  21.  
  22.                               -  or on the  -
  23.  
  24.                               Night Shift BBS 
  25.  
  26.                     (216) 941-9420      (216) 941-9921
  27.                     *** beta testing at its finest ***
  28.  
  29.  
  30. Here is a unique  way to let your users/members  pledge money toward the
  31. operation and maintenance of your DOORS.  It allows  the  user to choose
  32. the DOOR to  sponsor  and the amount of money  to pledge  per logon.  We
  33. are not talking about a ( LOT ) of money here, but  it can add up and it
  34. gives your users a novel way to pledge.  They can choose from 1¢ minimum
  35. to 10¢ maximum per logon.  They can check their balance at anytime AFTER
  36. the first logon and pledge. Their personal file is always updated. I did
  37. decide  to use individual  .DAT files  rather  than maintaining a  random
  38. access file. Deleting individual users is made easy this way, and all of
  39. the user files are kept in the PLEDGE directory.  
  40.  
  41. A user file is automatically created by using the  last 5 characters  of
  42. their last name  and the  first  3  characters of their first name + the
  43. .DAT  extension.  This  information is  obtained by a quick  read to the  
  44. DOOR.SYS file.
  45.  
  46. When they send in their  pledge (at anytime really), you can just delete
  47. their user file and add them to the PAIDUP.LST text file.
  48.  
  49. A separate program called PCHECK.EXE is launched from your LOGON.BAT as 
  50. the user logs on and re-writes their personal  pledge file, adding another
  51. increment to  the number  of logons.  This almost becomes a game to them!  
  52.  
  53. Full instructions are available to the user internally by selecting [I]
  54. for Instructions on the main menu.
  55.  
  56. ===========================
  57. USER PROCEDURE - FIRST TIME
  58. ===========================
  59.  
  60. 1. Enters the PLEDGE BANK door.
  61. 2. [L]ists the available doors on the BBS that can be pledged.
  62. 3. [R]eady to pledge is selected.
  63. 4. User enters the name of the door to be pledged.  ( Name doesn't have
  64.    to be exact; as long as the SysOp recognizes what it is ).
  65. 5. User enters the pledge amount from 1 - 10 cents.  Higher amounts or 0
  66.    will not be accepted and the input will once again be requested.
  67. 6. Pledge is recorded and the user leaves the door.
  68.  
  69. ==================================
  70. USER PROCEDURE - SUBSEQUENT VISITS
  71. ==================================
  72. 1. User can use the [S]how me my pledge account balance to see what he/she
  73.    has pledged.
  74.  
  75. NOTE:  If a user pledges another door at anytime before the original pledge
  76.        is paid off, that original pledge is over-written by the new pledge.
  77.  
  78.  
  79. ========
  80. FEATURES
  81. ========
  82. -> Supports COM Port speeds up to 38.4 baud.
  83. -> Supports FIFO buffers of the 16550 UART.
  84. -> Supports all communications ports.
  85. -> Does not require WATCHDOG or CTTY.  
  86. -> High speed text file display
  87. -> Utilizes user timeout function.
  88. -> Allows SysOp to shell to DOS.
  89. -> Allows SysOp to twit caller without them knowing SysOp is watching.
  90. -> Allows SysOp to increase or decrease time.
  91. -> Allows SysOp chat mode with word wrap.
  92. -> Provides SysOp with informative status line display.
  93. -> Recognizes multiple user systems ( .EXE file date 12/08/92 and later )
  94.  
  95. ==========     
  96. PLEDGE.CNF         sample
  97. ==========     
  98.  
  99. c:\GAP         <-- path to the GAP default directory ( where DOOR.SYS is )
  100. PC Niteline    <-- BBS Name
  101. 0              <-- must be 0 - designates a GAP BBS
  102.  
  103. Note: Remember to remove the comments from your config file and do
  104.       NOT leave any spaces.  It MUST consist of 3 lines!
  105.  
  106. BBSBASE "requires" BRUN45.EXE either in the BBSBASE directory or
  107. in your path!
  108.  
  109. ==========
  110. PCHECK.CNF
  111. ==========
  112.  
  113. This is handles exactly the same as the PLEDGE.CNF arrangement.
  114.  
  115. ==============================
  116. RUNNING LOCALLY FOR EVALUATION
  117. ==============================
  118.  
  119. You may run PLEDGE BANK locally to get a feel for the program and examine
  120. its appearance.  There are a couple of things you must do to make this
  121. happen.  Follow this setup and you will have no problem.
  122.  
  123. 1.  Create a directory and name it PLEDGE.
  124. 2.  UnZip your distribution archive into the directory.
  125. 3.  Make sure the first line in the PLEDGE.CNF file points to the PLEDGE
  126.     directory path.
  127. 4.  Place ANY valid DOOR.SYS in this directory and change the FIRST line
  128.     of the file to COM0:    (p.s. that is COM<zero>:)
  129. 5.  Launch the program by typing PLEDGE PLEDGE.CNF
  130.  
  131. ================
  132. MULTI-NODE SETUP
  133. ================
  134.  
  135. If you run multi-nodes, you must have a  separate .CNF and .BAT file  for
  136. each node, i.e. PLEDGE1.CNF, PLEDGE2.CNF......PLEDGE9.CNF
  137.  
  138. You MUST have the file PLEDGE.EXE  dated on  or after  12/10/92 to  run a
  139. multi-node  arrangement.  PLEDGE.EXE uses the COMMAND$ function that will
  140. pass the name of any .CNF file that you decide to use to the program.
  141.  
  142. ==============================
  143. FILES INCLUDED IN BBSBAS12.ZIP
  144. ==============================
  145.  
  146. PLEDGE.EXE       the executable DOOR program
  147. PCHECK.EXE       the executable PCHECK exit program
  148. PLEDGE.CNF       sample configuration file
  149. PCHECK.CNF       sample configuration file
  150. TOMTRON.REG      door registration form
  151. SYSOP.DOC        this documentation for SysOps
  152. HISTORY.DOC      update reports for BBSBASE
  153. PAIDUP(G)       *SysOp defined text file showing paid pledges
  154. DOORLST(G)      *SysOp defined text file showing your BBS DOOR names
  155.  
  156. ( NOTE ) : *The names of these files MUST be left as is - DO NOT CHANGE! 
  157.             You may NOT include XCODES in these text files as they will
  158.             not be realized.  You may use ANSI codes.  If you want both
  159.             color and non-color versions of these files, append the color
  160.             file with a "G" as in DOORLSTG
  161.  
  162.  
  163.  
  164. ======================
  165. NOTE TO NERVOUS SYSOPS
  166. ======================
  167.  
  168. PLEDGE BANK does NOT write to any of your GAP .DAT or system files at ANY
  169. time.  The only files that are created are the account.DAT files that are
  170. kept in the PLEDGE directory with the executable and support text files.
  171.  
  172. ==========     
  173. PLEDGE.BAT       sample (goes in your GAP default directory)
  174. ==========     
  175.  
  176. @ECHO OFF
  177. c:
  178. cd \gap\doors\PLEDGE       <--   Sample .BAT file
  179. PLEDGE PLEDGE.CNF
  180. cd \GAP
  181.  
  182. ============================
  183. !!! SPECIAL INSTRUCTIONS !!!   Follow instructions carefully 
  184. ============================
  185. In order to have your PCHECK program update their pledges, we must add
  186. the PCHECK program to the LOGON.BAT file in your GAP default directory.
  187. If you don't have one, then create one.  Simple add the following:
  188.  
  189. @ECHO OFF
  190. C:                     <-- or wherever you have the PLEDGE directory
  191. cd \gap\doors\pledge   <-- or whatever the correct path is
  192. PCHECK PCHECK.CNF      <-- launch with the correct .CNF extension
  193. cd \gap
  194.  
  195. PCHECK will look for a users pledge file and update it if it exists.
  196. There is also a short note of recognition OR non-recognition if a pledge
  197. file exists.
  198.  
  199.  
  200. =========
  201. IMPORTANT
  202. =========
  203.  
  204.  
  205.               (Please refer to TOMTRON.REG to register your door)
  206.  
  207.  
  208.                        PLEASE SUPPORT DOORWARE/SHAREWARE!
  209.  
  210.  
  211. Dear SysOp:
  212.  
  213. PLEDGE BANK is not crippled in ANY WAY other than the unregistered memo 
  214. in the title screen.  Registration is painless and inexpensive.  Please 
  215. promote the development of new doorware by registering your door.
  216.  
  217. Thank you!
  218.  
  219. Thomas W. Burker
  220. TomTron Software Development
  221. PC Niteline BBS
  222. 216/942-9451  / HST D/S 16.8
  223.